home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / program / ddmoduls.lha / dd_Modules / dd_hardware / dd_ciatimer.doc < prev    next >
Text File  |  1995-04-01  |  2KB  |  95 lines
  1. dd_blackboxes/dd_ciatimer
  2.  
  3. NAME
  4.  
  5.   dd_ciatimer.m -- oo class for cia hardware timers (V37)
  6.   dd_ciatimer_v40.m -- oo class for cia hardware timers (V40)
  7.  
  8. AUTHOR
  9.  
  10.   Leon Woestenberg of Digital Disturbance (Email: leon@stack.urc.tue.nl)
  11.  
  12. DESCRIPTION
  13.  
  14.   The dd_ciatimer class provides a system friendly way of using the Amiga
  15.   cia hardware timer devices. These timers can be used for high precision
  16.   timing of interrupts, output signals etc.
  17.  
  18. FEATURES
  19.  
  20.   Allocates any of the four timers, instead of just trying for one of
  21.   them. The wanted cia and timer can be set, but in fallback mode, any
  22.   other timer can be used if the prefered one was in use.
  23.  
  24.   There are two class implementations, one for Kickstart v37+ and one
  25.   for v40+ equipped Amigas. The class interface is exactly the same,
  26.   while the (hidden) implementation differs a lot. This shows the power
  27.   of data hiding of object oriented programming.
  28.  
  29.   The class interface uses tag items, a well known way of accessing
  30.   operating system functions since v37.
  31.  
  32. METHODS
  33.  
  34.   new -- construct a class instance
  35.  
  36.     SYNOPSIS
  37.       instance.new(tags:PTR TO tagitem)
  38.  
  39.     TAGS
  40.       DDA_CIA_Interrupt (PTR TO is) - Obligatory pointer to interrupt
  41.         structure that handles the timer interrupts.
  42.  
  43.       DDA_CIA_UseCIAA (LONG) - Flag indicating if a timer of CIA A
  44.         should be used. If not, CIA B is used.
  45.  
  46.       DDA_CIA_UseTimerA (LONG) - Flag indicating if a timer A should
  47.         be used. If not, timer B is used.
  48.  
  49.       DDA_CIA_FallBack (LONG) - If TRUE, any timer can be used. The
  50.         prefered timer is tried first.
  51.  
  52.     RESULT
  53.        Returns FALSE if the initialization failed.
  54.  
  55.   set -- set attributes
  56.  
  57.     SYNOPSIS
  58.       instance.set(tags:PTR TO tagitem)
  59.  
  60.     TAGS
  61.  
  62.       DDA_CIA_MicroSecs (LONG) - The countdown cycle time in microseconds
  63.         (µs = 1/1000000 of a second).
  64.  
  65.   start -- start timer
  66.  
  67.     SYNOPSIS
  68.       instance.start()
  69.  
  70.   stop -- stop timer
  71.  
  72.     SYNOPSIS
  73.       instance.stop()
  74.  
  75.   end -- destruct a class instance
  76.  
  77.     SYNOPSIS
  78.       instance.end()
  79.  
  80. TODO
  81.  
  82.   - Use method tags as in DoMethod, instead of using seperate method calls.
  83.   - Comment and clean up the sources.
  84.  
  85. BUGS
  86.  
  87.   The v40+ implementation is always in fallback mode. This is built in
  88.   the lowlevel.library so there is now way to get the wanted timer for
  89.   sure using this implementation.
  90.  
  91. SEE ALSO
  92.  
  93.   dd_ciatimertest.e
  94.  
  95.